Clarify documentation in attach/detachInterrupt syntax section #555
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
robsoncouto
reviewed
Mar 21, 2019
| @@ -59,7 +59,7 @@ For more information on interrupts, see http://gammon.com.au/interrupts[Nick Gam | |||
| === Syntax | |||
| `attachInterrupt(digitalPinToInterrupt(pin), ISR, mode);` (recommended) + | |||
| `attachInterrupt(interrupt, ISR, mode);` (not recommended) + | |||
| `attachInterrupt(pin, ISR, mode);` (Not recommended. Arduino SAMD Boards, Uno WiFi Rev2, Due, 101 only) | |||
| `attachInterrupt(pin, ISR, mode);` (Not recommended. This syntax is for use with Arduino SAMD Boards, Uno WiFi Rev2, Due, 101 only.) | |||
There was a problem hiding this comment.
Hi per
I think this is still somewhat confusing. What do you think of replacing
Not recommended. This syntax is for use with Arduino SAMD Boards, Uno WiFi Rev2, Due, 101 only.
for
Not recommended. Additionally, this syntax only works on Arduino SAMD Boards, Uno WiFi Rev2, Due, and 101?
Feedback was recieved that it wasn't clear whether the second sentence of the attachInterrupt(pin, ISR, mode) syntax description was related to the first sentence (i.e. is the syntax not recommended for Arduino SAMD Boards, Uno WiFi Rev2, Due, 101 only and the syntax is recommended for any other board type?).
|
@robsoncouto I have now updated this as you suggested. |
|
Awesome. Merged |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feedback was recieved that it wasn't clear whether the second sentence of the attachInterrupt(pin, ISR, mode) syntax description was related to the first sentence (i.e. is the syntax not recommended for Arduino SAMD Boards, Uno WiFi Rev2, Due, 101 only and the syntax is recommended for any other board type?).
As the notes for the syntax section grow longer, it makes me think that the standard formatting of this section is not ideal. This is a similar situation to what I've already reported for the Parameters section (#533), so it would make sense to apply whichever updated formatting standard that's decided on for the Parameters section to the Syntax section as well.
Originally reported at http://forum.arduino.cc/index.php?topic=598501.msg4064897#msg4064897